Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Properly sort modules when building the API documentation #231

Merged
merged 7 commits into from
Jun 6, 2024
Merged

docs: Properly sort modules when building the API documentation #231

merged 7 commits into from
Jun 6, 2024

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Jun 6, 2024 •
edited
Loading

Proposed changes

The API documentation currently has the modules sorted non-alphabetically when built on a Unix OS, this PR fixes that.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 requested a review from a team as a code owner June 6, 2024 19:42
@nfelt14 nfelt14 added bug Something isn't working documentation Improvements or additions to documentation labels Jun 6, 2024
@tek-githubbot-1010 tek-githubbot-1010 requested a review from a team June 6, 2024 19:42
@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 19:42 — with GitHub Actions Inactive
@codecov Codecov
Copy link

codecov bot commented Jun 6, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fac1299) to head (75c29fa).
Report is 56 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main      #231   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          150       150           
  Lines         4138      4138           
  Branches       651       651           
=========================================
  Hits          4138      4138

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 19:52 — with GitHub Actions Inactive
@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 20:07 — with GitHub Actions Inactive
@nfelt14 nfelt14 changed the title docs: Always use alphabetical sorting for modules when building the API documentation WIP: docs: Always use alphabetical sorting for modules when building the API documentation Jun 6, 2024
@nfelt14 nfelt14 added the WIP label Jun 6, 2024
@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 20:11 — with GitHub Actions Inactive
@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 20:48 — with GitHub Actions Inactive
@nfelt14 nfelt14 changed the title WIP: docs: Always use alphabetical sorting for modules when building the API documentation WIP: docs: Properly sort modules when building the API documentation Jun 6, 2024
@nfelt14 nfelt14 changed the title WIP: docs: Properly sort modules when building the API documentation docs: Properly sort modules when building the API documentation Jun 6, 2024
@nfelt14 nfelt14 temporarily deployed to package-build June 6, 2024 22:48 — with GitHub Actions Inactive
@nfelt14 nfelt14 enabled auto-merge (squash) June 6, 2024 22:57
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 6, 2024 •
edited
Loading

Test Results (ubuntu)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 1 1
tests/test_alternative_connection_addresses.py 19 19
tests/test_awgs.py 1 1
tests/test_config_parser.py 38 38
tests/test_device_manager.py 18 18
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_helpers.py 71 71
tests/test_ieee_scpi_cmds.py 1 1
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 6 6
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 4 4
TOTAL 188 188

Link to workflow run

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 6, 2024 •
edited
Loading

Test Results (windows)

path passed subtotal
tests\test_afgs.py 2 2
tests\test_alias_dict.py 1 1
tests\test_all_device_drivers.py 1 1
tests\test_alternative_connection_addresses.py 19 19
tests\test_awgs.py 1 1
tests\test_config_parser.py 38 38
tests\test_device_manager.py 18 18
tests\test_devices_legacy_tsp_ieee_cmds.py 3 3
tests\test_helpers.py 71 71
tests\test_ieee_scpi_cmds.py 1 1
tests\test_margin_testers.py 5 5
tests\test_pi_device.py 1 1
tests\test_psu.py 1 1
tests\test_rest_api_device.py 10 10
tests\test_scopes.py 6 6
tests\test_singleton.py 1 1
tests\test_smu.py 4 4
tests\test_ss.py 1 1
tests\test_tm_devices.py 4 4
TOTAL 188 188

Link to workflow run

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 6, 2024 •
edited
Loading

Test Results (macos)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 1 1
tests/test_alternative_connection_addresses.py 19 19
tests/test_awgs.py 1 1
tests/test_config_parser.py 38 38
tests/test_device_manager.py 18 18
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_helpers.py 71 71
tests/test_ieee_scpi_cmds.py 1 1
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 6 6
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 4 4
TOTAL 188 188

Link to workflow run

@nfelt14 nfelt14 merged commit 2576bbd into tektronix:main Jun 6, 2024
64 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelwagoner michaelwagoner michaelwagoner approved these changes

Assignees

@nfelt14 nfelt14

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nfelt14 @michaelwagoner